Documentation facelift #275
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #275 +/- ##
=======================================
Coverage 87.09% 87.09%
=======================================
Files 15 15
Lines 1279 1279
=======================================
Hits 1114 1114
Misses 165 165 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
not sure if it fits in this PR or a future one, but we have a lot of example docs implemented within docstrings in various parts of the code (i am one of the guilty parties). as part of a fuller refactor, we should decide whether to leave that as-is, migrate it to specific |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This draft PR modernizes the documentation by switching to use
sphinx_astropy.conf.v2withpydata-sphinx-theme. The PR mainly rearranges existing documentation without adding much new text at the moment (I've written a bit about tracing, but this is a work in progress).The PR is not ready for merging yet because some information is still duplicated, and some important topics (such as contributing) require further work.